home *** CD-ROM | disk | FTP | other *** search
/ Visual Cafe 3 / Visual Cafe 3.ISO / Vcafe / JFC.bin / README.txt < prev    next >
Text File  |  1998-06-30  |  9KB  |  244 lines
  1.  
  2.                 README
  3.  
  4. Welcome to this Swing release!  This release includes
  5. the Swing libraries, some examples, and API documentation.
  6.  
  7. This file has four sections:
  8.  
  9. - Quick Start
  10. - Using Swing Components in an IDE
  11. - Compiling and Running Swing Applications without an IDE
  12. - What's In This Release
  13.  
  14.     -----------------------------------------------------------
  15.     VERSION NOTES
  16.  
  17.     This release is called Swing 1.0.3 (also known as JFC 1.1).
  18.     Swing 1.0.3 is an interim release created to support the
  19.     concurrent release of Java Plug-in.  See CHANGES.txt for a
  20.     list of the four bugs fixed in Swing 1.0.3.  Many more bug
  21.     fixes and performance enhancements will be in the upcoming
  22.     JDK 1.2 beta release and its corresponding JFC 1.1 release.
  23.  
  24.     This Swing release relies on bug fixes first released in JDK
  25.     1.1.5.  If you don't have 1.1.5 or a later release, please
  26.     get it.  We recommend building Swing applications with the
  27.     most current JDK release.  See the following URL for
  28.     information on downloading the JDK:
  29.  
  30.           http://java.sun.com/products/jdk/1.1
  31.  
  32.     ---------------------------------------------------------
  33.  
  34.  
  35. ===========
  36. Quick Start
  37. ===========
  38.  
  39. Please read the License (LICENSE.txt) before using this release.
  40.  
  41. Please visit the Swing Web site, The Swing Connection.  That's
  42. the place where we're putting the information developers ask us
  43. for the most, with the content coming straight from the
  44. designers and implementers of Swing.  Here's the URL:
  45.  
  46.     http://java.sun.com/products/jfc/swingdoc-current/
  47.  
  48. The Java Tutorial has ever-growing coverage of Swing.  To view the
  49. Swing section of the Tutorial, point your Web browser at this URL:
  50.  
  51.     http://java.sun.com/Series/Tutorial/ui/swing/index.html
  52.     
  53. The remainder of this section tells you how to run an application
  54. (SwingSet) that showcases all the Swing components.  
  55.  
  56.  
  57. A. If you're running Solaris:
  58. -----------------------------
  59.  
  60. 1. Set your JAVA_HOME environment variable to be the top directory
  61.    of the JDK release you're using. For example:
  62.  
  63.     setenv JAVA_HOME /home/me/jdk1.1.6
  64.     
  65. 2. Go to the examples directory, and then to its SwingSet subdirectory.
  66.  
  67. 3. Execute the runnit command:
  68.  
  69.     runnit
  70.  
  71. 4. If it doesn't run successfully, unset your CLASSPATH environment
  72.    variable and type runnit again:
  73.  
  74.         unsetenv CLASSPATH
  75.     runnit   
  76.  
  77. 5. Read the README.txt file in the SwingSet directory for help
  78.    using the SwingSet example.
  79.  
  80.  
  81. B. If you're running Windows NT:
  82. ---------------------------------
  83.  
  84. 1. Double-click the System icon inside the Control Panel. When the
  85.    System Properties dialog box opens, place the following
  86.    variables in the lower list box, which is labeled "User
  87.    Variables." (Be careful not to change your system environment
  88.    variables, which appear in the upper list box.)
  89.  
  90.        JAVA_HOME      C:\JDK1.1.6
  91.        SWING_HOME     C:\swing-1.0.3
  92.        CLASSPATH      .;%JAVA_HOME%\lib\classes.zip
  93.        PATH           %PATH%;%JAVA_HOME%\bin
  94.    
  95.    These settings assume that you have installed both the JDK and the 
  96.    Swing tool set on drive C. If either these toolkits has been installed
  97.    on a different drive, substitute that drive's designator wherever it
  98.    is appropriate.
  99.    
  100. 2. From the Windows Start menu or from the Control Panel, open a console 
  101.    (MS-DOS-style) window.
  102.    
  103. 3. In the console window you have opened, navigate to the examples
  104.    directory, and then to its SwingSet subdirectory.
  105.  
  106. 4. From your console window, execute the runnit command:
  107.  
  108.     runnit
  109.  
  110. 5. Read the README.txt file in the SwingSet directory for help
  111.    using the SwingSet example.
  112.  
  113.  
  114. C. If you're running Windows 95:
  115. ---------------------------------
  116.  
  117. 1. Open your favorite text editor and add the following environment-variable
  118.    settings to your system's AUTOEXEC.BAT file:
  119.    
  120.        set JAVA_HOME=C:\JDK1.1.6
  121.        set SWING_HOME=C:\swing-1.0.3
  122.        set CLASSPATH=.;%JAVA_HOME%\lib\classes.zip
  123.        set PATH=%PATH%;%JAVA_HOME%\bin
  124.    
  125.    These settings assume that you have installed both the JDK and the 
  126.    Swing tool set on drive C. If either these toolkits has been installed
  127.    on a different drive, substitute that drive's designator wherever it
  128.    is appropriate.
  129.    
  130. 2. Perform steps 2 through 5 of the instructions listed under the preceding
  131.    heading, "If you're runnning Windows NT."
  132.  
  133. 3. If you encounter an "Out of environment space" error, then you'll
  134.    need to increase the size of the environment table.  You can do
  135.    this at the command line (which is temporary) or by editing a
  136.    configuration file to make a permanent change (which requires
  137.    restarting your computer).
  138.  
  139.    To temporarily increase environment space, enter the following
  140.    at the DOS prompt:
  141.  
  142.        command /e:8192
  143.  
  144.    To permanently increase environment space, add the following 
  145.    line to your CONFIG.SYS file and then restart your system:
  146.  
  147.        shell=command.com /e:8192 /p
  148.  
  149.    Once you've increased the size of the environment table, try
  150.    running SwingSet again.
  151.  
  152.  
  153. ================================
  154. Using Swing Components in an IDE
  155. ================================
  156.  
  157. To use Swing components in an IDE, such as Borland's JBuilder,
  158. Symantec's Cafe, Sun's JavaWorkshop, or IBM's VisualAge, you must
  159. import the swingall.jar file. The swingall.jar file includes the
  160. base Swing implementation, several looks and feels (Metal, Windows,
  161. and Motif), and information that make the Swing components work
  162. as beans.
  163.  
  164. The swingall.jar file is necessary only if you plan to use Swing
  165. in one of the IDE environments, or if you would like to simply
  166. include one "all inclusive" jar file in your CLASSPATH or
  167. application.
  168.  
  169.  
  170. =======================================================
  171. Compiling and Running Swing Applications without an IDE
  172. =======================================================
  173.  
  174. This section tells you how to compile and run your own programs.
  175. You don't need to read this section to be able to run the examples
  176. included in this release, since they all are pre-compiled and
  177. provide "runnit" or "runapplet" scripts.  As long as you have your
  178. environment variables set as described previously in this file,
  179. you should be able to run the Swing examples.
  180.  
  181. When you compile a Swing program, make sure that the swing.jar
  182. file is in the class path.  If you use the "-classpath" compiler
  183. option, be sure to also specify the appropriate JDK classes.zip 
  184. file and "." (or whatever directory the source code lives under).
  185.  
  186. For example, on Solaris:
  187.     /usr/local/java/jdk1.1.6/bin/javac -deprecation -classpath .:/usr/local/java/swing-1.0.3/swing.jar:/usr/local/java/jdk1.1.6/lib/classes.zip MySwingProgram.java
  188.  
  189. On Windows:
  190.     C:\JDK1.1.6\bin\javac -deprecation -classpath .;C:\JDK1.1.6\lib\classes.zip;C:\swing-1.0.3\swing.jar MySwingProgram.java
  191.  
  192. When running a Swing application, make sure that the class path
  193. contains not only whatever you needed to compile the application,
  194. but also the JAR files for any platform-specific look and feel
  195. you're using.  If you use only the Java look and feel (Metal), then
  196. you don't need an additional JAR file, since Metal is included in
  197. swing.jar.
  198.  
  199. For example, on Solaris:
  200.     /usr/local/java/jdk1.1.6/bin/java -classpath .:/usr/local/java/swing-1.0.3/swing.jar:/usr/local/java/jdk1.1.6/lib/classes.zip MySwingProgram
  201.  
  202. On Windows (with Windows look and feel):
  203.     C:\JDK1.1.6\bin\java -classpath .;C:\JDK1.1.6\lib\classes.zip;C:\swing-1.0.3\swing.jar;C:\swing-1.0.3\windows.jar MySwingProgram
  204.  
  205.  
  206. ======================
  207. What's In This Release
  208. ======================
  209.  
  210. This release contains the following:
  211.  
  212. README.txt        This file.
  213. README.html        Links to interesting files (such as this one).
  214. LICENSE.txt        Software license.
  215. CHANGES.txt        Notes on changes since the previous release.
  216. NOTES.txt        Miscellaneous notes, including how to reach us.
  217. src.zip            Swing source code.
  218. doc/api/overview-summary.html 
  219.             Automatically generated Swing API documentation.
  220.  
  221. swing.jar            The Swing classes.  DO NOT UNARCHIVE THIS FILE!
  222. windows.jar             The Windows look and feel.  DO NOT UNARCHIVE!
  223. motif.jar           The Motif look and feel.  DO NOT UNARCHIVE!
  224. beaninfo.jar        Beans-related files and classes.  DO NOT UNARCHIVE!
  225. swingall.jar        All of the above (useful for IDEs).  DO NOT UNARCHIVE!
  226. multi.jar        An experimental multiplexing look and feel.  DO NOT UN-
  227.             ARCHIVE!
  228.  
  229. examples/SwingSet    The comprehensive Swing example.
  230. examples/Simple        A simple Swing application.
  231. examples/SwingApplet    A simple Swing applet.
  232. examples/SampleTree    An example using Swing tree features.
  233. examples/Stylepad    An example using Swing text features.
  234. examples/Notepad    Another text example.
  235. examples/DBDemos    Files to set up databases for use with JDBC.
  236. examples/Table        JTable/JDBC database connectivity examples.
  237. examples/Metalworks    Demonstrates the Metal look and feel.
  238. examples/FileChooserDemo An example using JFileChooser.
  239.  
  240.  
  241. Have fun using Swing!
  242.  
  243. --The Swing Team
  244.